Skip to main content

requestPlan

Kick off plan generation for a user

GraphQL Schema

extend type mutation {
"""Kick off plan generation for a user"""
requestPlan(input: RequestPlanInput!): RequestPlanPayload!
}

Arguments

NameTypeDescription
input[RequestPlanInput!](/04-reference/05-Input Objects/RequestPlanInput.mdx)

Response Shape

This mutation returns RequestPlanPayload!

NameTypeDescription
successBoolean!Whether the mutation was successful
errorErrorTypeError information